Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move alternative ways to install mise to a separate page #2930

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

hverlin
Copy link
Contributor

@hverlin hverlin commented Nov 5, 2024

As suggested in #2440, the getting-started page might be too intimidating for someone new to mise.

2/3rd of the page is filled up with: Alternate Installation Methods, Shells, and Uninstalling. I think it makes sense to link to this content in other pages but for the majority of users this is only adding noise and making them want to leave the docs or search for more examples.

To address this, this PR adds an installing-mise.md page which lists all the ways that mise can get installed.

A little into the page it offers you the choice about activate vs shims vs none. Most people new to Mise won't want to make choices like this right away since it requires research to understand the consequences.

There is very little explanation about what activate actually does at this point. It doesn't need to be in-depth like the FAQ, just something like "it updates your env vars and path every time your prompt is run to ensure you use the correct versions"

Moved the shims activation method to shims and added a short explanation.

Other changes:

  • Made all the code blocks easier to copy-paste by removing the $
  • Updated the using mise section of the getting started so that users try to use both mise exec -- node -v and node -v
  • Add section on how to set up the autocompletion

@hverlin hverlin marked this pull request as draft November 5, 2024 13:05
@hverlin hverlin force-pushed the hv/installing-mise branch 2 times, most recently from 789876d to 588e8bd Compare November 5, 2024 13:36
$ mise exec -- node -v
v20.x.x
mise exec -- node -v
# v22.x.x
```

:::tip
Use `mise x -- node -v` or set a shell alias in your shell's rc file like `alias x="mise x --"` to
Copy link
Contributor Author

@hverlin hverlin Nov 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This tip is nice, however I would perhaps move it to another page?

@hverlin hverlin marked this pull request as ready for review November 5, 2024 14:55
@hverlin hverlin force-pushed the hv/installing-mise branch from 588e8bd to 8510835 Compare November 5, 2024 16:39
```

```sh [fish]
mise completion fish > ~/.config/fish/completions/mise.fish
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't use fish. However, I still tried it to make sure it works. I am getting the following error (even with usage installed)

root@2c295de84df0 /# source ~/.config/fish/completions/mise.fish
~/.config/fish/completions/mise.fish (line 6): 'return' outside of function definition
    return 1
    ^
from sourcing file ~/.config/fish/completions/mise.fish

removing the return 1 fixes it

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you don't source completion files in fish

@jdx jdx merged commit c4b1628 into jdx:main Nov 5, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants